Management API

Base Resource URL:

     https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/post-rules

Description:

Returns a set of rules to validate AVS/CSC response codes of a merchant or merchant account.

Available sub-resources:

Resource URL Description
https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/post-rules/[rule-id]    Post-Rule to validate AVS/CSC response codes

Supported Actions:

copyFrom  
Method:  GET       Implicit:  No       Returns:  ServiceResponse      
Consumes:  json, xml, xurl  Produces:  json, xml, xurl 
 
Copies the list of all available rules between selected merchants.

copyTo  
Method:  GET       Implicit:  No       Returns:  ServiceResponse      
Consumes:  json, xml, xurl  Produces:  json, xml, xurl 
 
Copies the list of all available rules between selected merchants.

create  
Method:  POST       Implicit:  Yes       Returns:  PostRule      
Consumes:  json, xml, xurl  Produces:  json, xml, xurl 
 
Creates a new rule.

find  
Method:  GET       Implicit:  Yes       Returns:  n/a      
Consumes:  json, xml, xurl  Produces:  json, xml, xurl 
 
Finds all rules defined for the merchant.

Parameters:
# Name Type Required Default Description
01 offset Integer No 0 Index of the first record returned to the customer from the search result of a web search.
02 limit Integer No 100 Maximum number of records to load per single search web call made by the customer.

modify  
Method:  POST       Implicit:  Yes       Returns:  PostRule      
Consumes:  json, xml, xurl  Produces:  json, xml, xurl 
 
Allows to modify the post-rule for the merchant.
The used have to send the ID of the post-rule and fields that are to be changed in the request.

priority  
Method:  POST       Implicit:  Yes       Returns:  PostRule      
Consumes:  json, xml, xurl  Produces:  json, xml, xurl 
 
Allows to change the execution priority of the post-rule.

Parameters:
# Name Type Required Default Description
01 value String Yes - Parameter can take one of the following values:
highest - assignes a highest priority to the rule
lowest - assignes a lowest priority to the rule
+N - increases priority of the rule by N, where N is an integer value
-N - decreases priority of the rule by N, where N is an integer value

Copyright © TidyPay. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.